Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Improving the doc #138

Merged
merged 4 commits into from
Oct 15, 2023
Merged

WIP: Improving the doc #138

merged 4 commits into from
Oct 15, 2023

Conversation

ldevillez
Copy link
Collaborator

@ldevillez ldevillez commented Sep 17, 2023

Description

Doc is still a bit behind the actual status of the repo:

  • Update of Sphinx version
  • Changing theme to Furo
  • Auto generate list of args (avoid repeating them) with sphinx-argparse for command line module
  • Auto generate function doc for package module

Fixes #132

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

Building of the doc

Checklist:

  • My code follows the style guidelines of this project (black/pylint)
  • I have updated the changelog with the corresponding changes
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@ldevillez ldevillez merged commit 4c52ee5 into master Oct 15, 2023
4 checks passed
@ldevillez ldevillez deleted the update_theme_doc branch November 17, 2023 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve the doc
1 participant